Document
The Document object contains information about the requested document based on the document identifier.
| Parameter | Type | Description |
|---|---|---|
| DocumentID | string | A unique identifier associated with a document. |
| StoredDocID | string | A reference to the unique identifier (DocID) associated with a document. |
| OrganizationID | string | A unique identifier for the root organization associated with the document. |
| InstanceID | string | A unique identifier associate with the document instance. |
| InstanceBarcodeValue | string | The barcode value associated with the instance of the document. |
| PageCount | ExpereInteger | The number of paginated documents (not including documents that are not paginated). |
| DisplayName | string | The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). |
| InstanceFileName | string | The instance file name associated with the document instance. This is generated as a conversion of the dispay name (converting the display name to a file name) in a maner that replaces any special characters or spaces in the display name with an underscore (_). |
| Type | DocumentType | Object defining the format type for a document type (based on an enumerated value). |
| FragmentedName | string | The document name when used as a fragment. |
| Autoselected | ExpereBoolean | A boolean defining if the document is marked for autoselection. A TRUE value indicates the document is autoselected; a FALSE value indicates it is not autoselected. |
| Prepare | ExpereBoolean | A boolean defining if the document is a prepared document. A TRUE value indicates the document is prepared; a FALSE value indicates it is not prepared. |
| Suggested | ExpereBoolean | A boolean defining if the document is a suggested document. A TRUE value indicates the document is suggested; a FALSE value indicates it is not suggested. |
| Format | DocumentFormatType | The format of the document. |
| Copy | ExpereInteger | The number of copies of the document associated with the instance. |
| AncillaryOutputOptions | ArrayOfAncillaryOutputOption | Array containing an unbound collection of AncillaryOutputOption objects. |
| Data | Data | Container object for transaction data inputs and outputs in binary (base64), text, or XML format. It will include all documents in the current packet. |
| DDRData | true | Indicates if there is any DDR data associated with the document. |